v1(Latest)v2

Forward Create Order API:

Description : Use this API to create an order on the RapidShyp platform.

Basic Information

NAME	DETAILS
Usage:	Mandatory
URL:	https://api.rapidshyp.com/rapidshyp/apis/v1/create_order
Request Type:	POST
Scheme:	HTTPS
Header (content-type):	application/json
Header (rapidshyp-token):	API-Key

Curl

curl --location 'https://api.rapidshyp.com/rapidshyp/apis/v1/create_order' \
--header 'rapidshyp-token: e779a465**********************1f34b64805e' \
--header 'Content-Type: application/json' \
--data-raw '{
"orderId": "EXTI_28",
"orderDate": "2024-08-08",
"pickupAddressName": "Seller 201301",
"pickupLocation": {
"contactName": "",
"pickupName": "",
"pickupEmail": "",
"pickupPhone": "",
"pickupAddress1": "",
"pickupAddress2": "",
"pinCode": ""
},
"rto_Location":
{
"rto_locationName":"RAPIDwsQAA",
"contactName": "RAPIDQasA",
"rtoEmail": "abc@gmail.com",
"rtoPhone": "9999999999",
"rtoAddress1": "aRAPIDQA",
"rtoAddress2": "",
"rtopinCode": "201301"
},
"storeName": "DEFAULT",
"billingIsShipping": true,
"shippingAddress": {
"firstName": "Mahesh Mehra",
"lastName": "EXT",
"addressLine1": "Delhi",
"addressLine2": "New Delhi",
"pinCode": "110002",
"email": "abc@gmail.com",
"phone": "9999999999"
},
"billingAddress": {
"firstName": "Jane",
"lastName": "Doegghgh",
"addressLine1": "456 Elm St",
"addressLine2": "Apt 101",
"pinCode": "110002",
"email": "jane.doe@example.com",
"phone": "9999999999"
},
"orderItems": [
{
"itemName": "Product 2",
"sku": "TEST14",
"description": "Description of product 1",
"units": 1,
"unitPrice": 10.0,
"tax": 0.0,
"hsn": "HSN123",
"productLength": 10.0,
"productBreadth": 5.0,
"productHeight": 2.0,
"productWeight": 0.5,
"brand": "Brand A",
"imageURL": "https://abcd.jpeg",
"isFragile": false,
"isPersonalisable": false,
"pickupAddressName" :""
},
{
"itemName": "Product 3",
"sku": "TEST18",
"description": "Description of product 2",
"units": 2,
"unitPrice": 20.0,
"tax": 0.0,
"hsn": "HSN456",
"productLength": 15.0,
"productBreadth": 7.0,
"productHeight": 3.0,
"productWeight": 0.8,
"brand": "Brand B",
"imageURL": "https://abcd.jpeg",
"isFragile": false,
"isPersonalisable": false,
"pickupAddressName" :""
}
],
"paymentMethod": "PREPAID",
"shippingCharges": 100.0,
"giftWrapCharges": 10.0,
"transactionCharges": 20.0,
"totalDiscount": 5.0,
"codCharges": 20.0,
"prepaidAmount": 50.0,
"packageDetails": {
"packageLength": 20.0,
"packageBreadth": 10.0,
"packageHeight": 5.0,
"packageWeight": 2000.0
}
}'

Request Parameters	Required	Remark	Validation
{
orderId	Mandatory	Seller order ID on channel/store/website	Minimum 1 character
orderDate	Mandatory	Order created date on channel/store/website	Format: YYYY-MM-DD
pickupAddressName	Conditionally-Mandatory	Pickup name created on Rapidshyp platform	API user can either pass pickup name or create pickup. If both details are shared, system will create order on the pickup name provided and will not create a new pickup location.
pickupLocation	Conditionally-Mandatory	Create pickup location on order creation itself
{
contactName	Mandatory	Location contact POC name	Minimum 1 character
pickupName	Mandatory	Name of the warehouse/store	Pickup address name must be between 3 and 75 characters long
pickupEmail	Mandatory	Location contact POC email
pickupPhone	Mandatory	Location contact POC phone number	Phone number must start from 6,7,8,9
pickupAddress1	Mandatory	Warehouse/store address line 1	Pickup address line 1 must be between 3 and 100 characters long
pickupAddress2	Non-Mandatory	Warehouse/store address line 2	If entered, Pickup address line 2 must be between 3 and 100 characters long
pinCode	Mandatory	Location Pincode	Must be 6 digit valid pincode
},
rto_Location	Non-Mandatory	Details of RTO location if different than pickup location	If user is adding RTO location then all the fields are mandatory to fill otherwise the RTO location would be considered as the pickup location
{
rto_locationName	Non-Mandatory
contactName	Mandatory	Location contact POC name
pickupEmail	Non-Mandatory	Location contact POC email
rtoPhone	Non-Mandatory	Location contact POC phone number	Phone number must start from 6,7,8,9
rtoAddress1	Non-Mandatory	Warehouse/store address line 1	Pickup address line 1 must be between 3 and 100 characters long
rtoAddress2	Non-Mandatory	Warehouse/store address line 2	If entered, Pickup address line 2 must be between 3 and 100 characters long
rtoPinCode	Non-Mandatory	Location Pincode	Must be 6 digit valid pincode
},
storeName	Mandatory	Store name created on Rapidshyp	If you have one custom channel, pass "DEFAULT"
billingIsShipping	Mandatory	Pass true if both shipping and billing is same. In case false, Billing address can’t be empty
shippingAddress	Mandatory
{
firstName	Mandatory	Customer first name	The combined length of the first and last name in the shipping address must be between 3 and 75 characters.
lastName	Non-Mandatory	Customer last name
addressLine1	Mandatory	Customer address line 1	Shipping address line 1 must be between 3 and 100 characters long
addressLine2	Non-Mandatory	Customer address line 2	If entered, Shipping address line 2 must be between 3 and 100 characters long
pinCode	Mandatory	Customer address pincode	Must be 6 digit valid pincode
email	Non-Mandatory	Customer email
phone	Mandatory	Customer phone number	Phone number must start from 6,7,8,9
},
billingAddress	Conditionally-Mandatory	Only pass incase billingIsShipping: false
{
firstName	Mandatory	Billing customer first name	The combined length of the first and last name in the shipping address must be between 3 and 75 characters.
lastName	Non-Mandatory	Billing customer last name
addressLine1	Mandatory	Billing customer address line 1	Billing address line 1 must be between 3 and 100 characters long
addressLine2	Non-Mandatory	Billing customer address line 2	If entered, Billing address line 2 must be between 3 and 100 characters long
pinCode	Mandatory	Billing customer address pincode	Must be 6 digit valid pincode
email	Mandatory	Billing customer email
phone	Mandatory	Billing customer phone number	Phone number must start from 6,7,8,9
},
orderItems	Mandatory	Item level details
{
itemName	Mandatory	Item name	Order line item name must be between 3 and 200 characters long
sku	Non-Mandatory	Item SKU Id	Order line item sku must be between 3 and 200 characters long
description	Non-Mandatory	Description of product	Minimum 1 character
units	Mandatory	Quantity of items	Item quantity must be greater than 0 in items.
unitPrice	Mandatory	Unit price of SKU inclusive of Taxes	Item unit price must be greater than 0 in items.
tax	Mandatory	Tax	Pass 0 in case of zero tax item
hsn	Non-Mandatory	HSN code
productLength	Non-Mandatory	Product dimension length	In cm
productBreadth	Non-Mandatory	Product dimension breadth	In cm
productHeight	Non-Mandatory	Product dimension height	In cm
productWeight	Non-Mandatory	Product dimension weight	In gm
brand	Non-Mandatory	Brand of product
imageURL	Non-Mandatory	Image URL
isFragile	Non-Mandatory		If fragile item, pass true
isPersonalisable	Non-Mandatory		If personalisable, pass true
pickupAddressName	Non-Mandatory	Define pickup location at item level to create multi-shipment for an order
},
],
paymentMethod	Mandatory	Payment mode of order	Payment mode — please choose from [COD, PREPAID]
shippingCharges	Non-Mandatory	Shipping charges
giftWrapCharges	Non-Mandatory	Gift wrap charges
transactionCharges	Non-Mandatory	Transaction charges
totalDiscount	Non-Mandatory	Total discount
totalOrderValue	Mandatory	Total order value
codCharges	Non-Mandatory	codCharges
prepaidAmount	Non-Mandatory	prepaidAmount	Pass partially paid amount in case of partial paid order. System then calculates collectable amount. Prepaid amount is only applicable on COD payment mode.
packageDetails	Mandatory
{
packageLength	Mandatory	packageLength	In cm
packageBreadth	Mandatory	packageBreadth	In cm
packageHeight	Mandatory	packageHeight	In cm
packageWeight	Mandatory	packageWeight	In gm
}
}

Response:

JSON

{

    "status": "SUCCESS",

    "remarks": "order created successfully.",

    "order_id": "ORD12345",

    "shipment": []

}

In the create order API you can use existing pickup location/create a pickup location/define pickup location on items.

Pickup location logic in request payload:

• Users can either enter pickup location on an order or on item level.

• If a user enters a pickup location on an order level,he can either use the existing pickup location or create a pickup location on order level.
• Incase he creates pickup on order level, new pickup location will be created in system and the rto address will be same as the pickup location created
• Users can only enter the pickup location name on item level. System won't provide pickup location creation on item level.
• If Users define pickup location on item level, the system will create orders with multiple shipment assigned to location provided in item line.